CruiseControl.NET : Modification Writer Task

This page last changed on Mar 14, 2009 by dcameron.

This task writes the detected modifications for the current integration to a file as XML. This enables the modifications to be used by external programs, such as within a NAnt build script.

Minimal configuration example:

<modificationWriter />

Full configuration example:

<modificationWriter>
     <filename>mods.xml</filename>
     <path></path>
     <appendTimeStamp>False</appendTimeStamp>
</modificationWriter>

Configuration Elements:

Node	Description	Type	Required	Default
filename	The filename for the file containing the modifications.	string	false	modifications.xml
path	The directory to write the xml file to.	string	false	the artifact directory
appendTimeStamp	Appends the integration start time to the filename, just before the extention. Making it possible to create a modification file per integration, without overwriting existing ones. Intended to be used with the ModificationReaderTask	bool	false	false
description	If filled in, this will be shown in the buildstage as the process name	string	false	n/a

Output format

The modifications are written as follows:

XML header.

<?xml version="1.0" encoding="utf-8"?>

Start of the group of modifications (even if just one).

<ArrayOfModification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">

Start of one modification.

<Modification>

The change number.

<ChangeNumber>... value .../ChangeNumber>

The comment.

<Comment>... value ...</Comment>

The user's email address.

<EmailAddress>... value ...</EmailAddress>

The affected file name.

<FileName>... value ...</FileName>

The affect file's folder name.

<FolderName>... value ...</FolderName>

The change timestamp, in yyyy-mm-ddThh:mm:ss.nnnn-hhmm format

<ModifiedTime>... value ...</ModifiedTime>

The operation type.

<Type>... value ...</Type>

The user name.

<UserName>... value ...</UserName>

The related URL.

<Url>... value ...</Url>

The file version.

<Version>... value ...</Version>

End of modification.

</Modification>

End of the group of modifications.

</ArrayOfModification>

Sample output

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfModification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Modification>
        <ChangeNumber>12245</ChangeNumber>
        <Comment>New Project for testing stuff</Comment>
        <EmailAddress>JUser@Example.Com</EmailAddress>
        <FileName>AssemblyInfo.cs</FileName>
        <FolderName>Dev\Server\Interface\Properties\</FolderName>
        <ModifiedTime>2006-11-22T11:11:00-0500</ModifiedTime>
        <Type>add</Type>
        <UserName>joe_user</UserName>
        <Url>http://www.example.com/index.html</Url>
        <Version>5</Version>
    </Modification>
    <Modification>
        <ChangeNumber>12244</ChangeNumber>
        <Comment>New Project for accessing web services</Comment>
        <EmailAddress>SSpade@Example.Com</EmailAddress>
        <FileName>Interface</FileName>
        <FolderName>Dev\Server\</FolderName>
        <ModifiedTime>2006-11-22T11:10:44-0500</ModifiedTime>
        <Type>add</Type>
        <UserName>sam_spade</UserName>
        <Url>http://www.example.com/index.html</Url>
        <Version>4</Version>
    </Modification>
</ArrayOfModification>